.. _ecmSxCmpOne_GetEnv:

ecmSxCmpOne_GetEnv
==================
------------------


SYNOPSIS
--------


.. code-block:: none

  t_success  ecmSxCmpOne_GetEnv(
    t_i32  NetID,
    t_i32  Axis,
    t_bool  *CmpCntrType,
    t_i32  *CmpMethod,
    t_f64  *CmpRefPos,
    t_i32  *OutSigLogic,
    t_i32  *OutSigOnTime,
    t_i32  *ErrCode
  )



DESCRIPTION
-----------


- ‘One-shot’ 모드 위치비교출력 기능을 위한 비교 조건 및 기타 환경 설정값을 반환합니다.



PARAMETER
---------


- NetID : Network 번호

- Axis : 대상 축 번호.

- :ref:`CmpCntrType  <ecat_enum_EEcmCmpCntrType>`  : 비교대상이 되는 위치값의 종류를 선택한다.

- :ref:`CmpMethod  <ecat_enum_EEcmCmpMethod>`  : 비교대상위치값고 기준위치값을 비교하는 방법을 설정한다. 

- CmpRefPos : 이 매개변수는 기준위치값을 설정하는 매개변수이다. 위치비교출력이 활성화되면, 이 기준값과 비교대상위치값을 비교하여 조건 만족(신호 출력)을 판단하게 된다.

- :ref:`OutSigLogic  <ecat_enum_EEcmSigLogic>`  : 비교조건이 만족되었을 때 출력되는 신호(CMP)의 신호 로직을 설정한다. 

- OutSigOnTime : 비교조건이 만족되었을 때 출력되는 신호(CMP)가 Active 상태로 유지되는 시간을 msec 단위로 설정한다.

- ErrCode : 이 매개 변수를 통하여 현재의 에러 코드를 반환합니다. 단, 이 매개 변수에 NULL을 전달하면 에러 코드를 반환하지 않습니다.




RETURN VALUE
------------


- 이 리턴값은 불 형(Boolean Type) 을 가지고 있습니다.


+-------+--------------------------------------+
| Value | Meaning                              |
+=======+======================================+
| 0     | 함수 수행에 실패하였음을 의미합니다. |
+-------+--------------------------------------+
| 1     | 함수 수행에 성공하였음을 의미합니다. |
+-------+--------------------------------------+


.. seealso::
  :ref:`ecmSxCmpOne_SetEnable` EXAMPLE 참고